The admin user can generate an API Key for a specific tenant in Backflipt platform. This API Key will be used to authenticate and authorize requests made to the Backflipt platform API endpoints.

To generate API Key

1. Log in to Backflipt platform using your admin credentials.
2. Navigate to Tenant Management menu.
3. Locate and select the specific tenant for which you want to generate an API Key.
4. Once you have selected the tenant, click the Generate API Key icon.
5. If API key is not generated, the following screen is displayed.
       
   
   
   Click Generate to generate a new API Key. After generating the API Key, it will be displayed on the screen or provided via email.
6. If the API key is already generated, the following screen is displayed. Click the copy icon to copy the generated API key.
       
   

      
7. You can send the generated API Key to the tenant or user system administrator who will be using it to make API requests.
8. Optionally, you may have the ability to manage and delete API Keys and regenerate the key if required.
   Ensure that only authorized individuals or systems have access to the API Key, as it grants permissions to interact with the Backflipt platform.

   Communicate and share the API Key through secure channels to maintain its confidentiality.

   In case the API Key is compromised or no longer required, follow the appropriate procedures to delete or revoke the key.

Top of page